Get SBC Devices

This request retrieves a list of configured SBC devices for a Service Provider tenant. When a new customer is created (Create New OC Customer from a Lead), a CLI script is applied to the SBC device including configuration of SIP entities. For example, IP group, Proxy Set, SIP Interface and IP-to-IP Routing.

URI

Copy

{{baseUrl}}/api/v2/sbc?allDetails=true

HTTP Method

GET

Request Parameters

Attribute	Type	Description
allDetails (includes Proxy Sets and CACProfiles)	boolean Default: false	When enabled retrieves ProxySets and CacProfiles configured for each SBC device.

Attribute

Type

Description

allDetails (includes Proxy Sets and CACProfiles)

boolean

Default: false

When enabled retrieves ProxySets and CacProfiles configured for each SBC device.

Example Response

Copy

[
    {
        "sbcId": 8,
        "name": "oc1.sandbox2.audiocodes.be [20.102.51.206]",
        "status": "Connected",
        "proxySets": [
            "ProxySet_0",
            "Teams",
            "SIPTrunk",
            "OperatorConnect",
            "Telnyx"
        ],
        "cacProfiles": [
            "5 sessions",
            "10 sessions",
            "20 sessions"
        ],
        "statusMessage": null
    }
]

HTTP Responses

■

200 OK

Attribute	Type	Description
sbcId	integer	SBC ID entry in the Known SBC Table (seeAdd SBC Devices).
name	string	Name of the SBC device.
status	string	Indicates whether the device is connected.
proxySets	list array	Retrieves the names of the Proxy Sets defined for the SBC device.
cacProfiles	list array	Retrieves the CAC profiles configured for the SBC device.
statusMessage	string	Status message.